home *** CD-ROM | disk | FTP | other *** search
/ SGI Performance Co-Pilot 1.3 / SGI Performance Co-Pilot 1.3.iso / dist / dist6.4 / pcp.idb / usr / share / catman / u_man / cat1 / pmdacisco.z / pmdacisco
Text File  |  1997-04-03  |  11KB  |  199 lines
  1.  
  2.  
  3.  
  4. PPPPMMMMDDDDAAAACCCCIIIISSSSCCCCOOOO((((1111))))                                                      PPPPMMMMDDDDAAAACCCCIIIISSSSCCCCOOOO((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ppppmmmmddddaaaacccciiiissssccccoooo, ppppaaaarrrrsssseeee, pppprrrroooobbbbeeee - Cisco router performance metrics domain agent
  10.      (PMDA)
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmddddaaaassss////cccciiiissssccccoooo////ppppmmmmddddaaaacccciiiissssccccoooo [----dddd _d_o_m_a_i_n] [----hhhh _h_e_l_p_f_i_l_e] [----iiii _p_o_r_t] [----llll
  14.      _l_o_g_f_i_l_e] [----PPPP _p_a_s_s_w_o_r_d] [----pppp] [----rrrr _r_e_f_e_s_h] [----uuuu _s_o_c_k_e_t] _h_o_s_t:_i_n_t_e_r_f_a_c_e-_s_p_e_c
  15.      [...]
  16.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmddddaaaassss////cccciiiissssccccoooo////ppppaaaarrrrsssseeee [options] _h_o_s_t:_i_n_t_e_r_f_a_c_e-_s_p_e_c [...]
  17.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmddddaaaassss////cccciiiissssccccoooo////pppprrrroooobbbbeeee [----PPPP _p_a_s_s_w_o_r_d] _h_o_s_t
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      ppppmmmmddddaaaacccciiiissssccccoooo is a Performance Metrics Domain Agent (PMDA) which extracts
  21.      performance metrics from one or more Cisco routers.
  22.  
  23.      A brief description of the ppppmmmmddddaaaacccciiiissssccccoooo command line options follows:
  24.  
  25.      ----dddd   It is absolutely crucial that the performance metrics _d_o_m_a_i_n number
  26.           specified here is unique and consistent.  That is, _d_o_m_a_i_n should be
  27.           different for every PMDA on the one host, and the same _d_o_m_a_i_n number
  28.           should be used for the same PMDA on all hosts.
  29.  
  30.      ----hhhh   The help text describing the available performance metrics is
  31.           obtained from files with the basename _h_e_l_p_f_i_l_e rather than the
  32.           default of /_v_a_r/_p_c_p/_p_m_d_a_s/_c_i_s_c_o/_h_e_l_p.
  33.  
  34.      ----iiii   Communicate with ppppmmmmccccdddd(1) via the given Internet _p_o_r_t.
  35.  
  36.      ----llll   By default a log file named _c_i_s_c_o._l_o_g is written in the directory
  37.           where ppppmmmmddddaaaacccciiiissssccccoooo is started, i.e. since ppppmmmmccccdddd(1) makes /_v_a_r/_a_d_m/_p_c_p_l_o_g
  38.           (or $$$$PPPPCCCCPPPP____LLLLOOOOGGGGDDDDIIIIRRRR if set in the environment) its current directory,
  39.           the default logfile for ppppmmmmddddaaaacccciiiissssccccoooo is ${_P_C_P__L_O_G_D_I_R-
  40.           /_v_a_r/_a_d_m/_p_c_p_l_o_g}/_c_i_s_c_o._l_o_g.  If the log file cannot be created or is
  41.           not writable, output is written to the standard error instead.  The
  42.           ----llll option specifies an alternative name for the log file.
  43.  
  44.      ----PPPP   By default, it is assumed there are no user-level passwords required
  45.           to access the Cisco's telnet port.  If user-level passwords have
  46.           been enabled on the Ciscos, then those passwords must be specified
  47.           to ppppmmmmddddaaaacccciiiissssccccoooo.  If specified with the ----PPPP option, _p_a_s_s_w_o_r_d will be
  48.           used as the default user-level password for all Ciscos.  See also
  49.           the INTERFACE IDENTIFICATION section below.
  50.  
  51.      ----pppp   Communicate with ppppmmmmccccdddd(1) via a pipe.
  52.  
  53.      ----rrrr   ppppmmmmddddaaaacccciiiissssccccoooo will refresh the current values for all performance
  54.           metrics by contacting each Cisco router once every _r_e_f_r_e_s_h seconds.
  55.           The default _r_e_f_r_e_s_h is 120 seconds.
  56.  
  57.      ----uuuu   Communicate with ppppmmmmccccdddd(1) via the given Unix domain _s_o_c_k_e_t.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PPPPMMMMDDDDAAAACCCCIIIISSSSCCCCOOOO((((1111))))                                                      PPPPMMMMDDDDAAAACCCCIIIISSSSCCCCOOOO((((1111))))
  71.  
  72.  
  73.  
  74. IIIINNNNTTTTEEEERRRRFFFFAAAACCCCEEEE IIIIDDDDEEEENNNNTTTTIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  75.      As each Cisco router can support multiple network interfaces and/or
  76.      multiple communications protocols, it is necessary to tell ppppmmmmddddaaaacccciiiissssccccoooo
  77.      which interfaces are to be monitored.
  78.  
  79.      The _h_o_s_t:_i_n_t_e_r_f_a_c_e-_s_p_e_c arguments on the command line define a particular
  80.      interface on a particular Cisco router.  _h_o_s_t should be a hostname or a
  81.      ``dot-notation'' IP address that identifies the telenet port of a
  82.      particular Cisco router.  There are several components of the _i_n_t_e_r_f_a_c_e-
  83.      _s_p_e_c as follows.
  84.  
  85.      protocol
  86.           One of the letters aaaa, EEEE, eeee, ffff, hhhh or ssss respectively for ATM,
  87.           FastEthernet, Ethernet, FDDI, HSSI or serial.
  88.  
  89.      interface
  90.           Depending on the model of the Cisco, this will either be an integer
  91.           or a pair of integers separated by a slash (``/'').
  92.  
  93.      To discover the valid interfaces on a particular Cisco, connect to the
  94.      telnet port (using tttteeeellllnnnneeeetttt(1)) and enter the command "show int" and look
  95.      for the interface identifiers following the keywords ``Ethernet'',
  96.      ``Fddi'' or ``Serial''.
  97.  
  98.      Alternatively run the pppprrrroooobbbbeeee command.
  99.  
  100.      password
  101.           If there is a user-level password, and it is different to the
  102.           default (see ----PPPP above), it may be optionally specified here by
  103.           appending a question mark (``?'') and the password to the end of
  104.           _i_n_t_e_r_f_a_c_e-_s_p_e_c.
  105.  
  106.      The following are examples of valid _i_n_t_e_r_f_a_c_e-_s_p_e_c arguments.
  107.                my-router:e1/2
  108.                123.456.789.0:s0
  109.                wancisco:f2/3?trust_me
  110.                cisco34.foo.bar.com:e2?way2cool
  111.  
  112. HHHHEEEELLLLPPPPEEEERRRR UUUUTTTTIIIILLLLIIIITTTTIIIIEEEESSSS
  113.      The pppprrrroooobbbbeeee command may be used to discover the names of all interfaces for
  114.      a particular Cisco router identifiled by _h_o_s_t.  The ----PPPP argument is the
  115.      same as for ppppmmmmddddaaaacccciiiissssccccoooo.
  116.  
  117.      The ppppaaaarrrrsssseeee command takes exactly the same arguments as ppppmmmmddddaaaacccciiiissssccccoooo, but
  118.      executes outside the control of any ppppmmmmccccdddd(1) and so may be used to
  119.      diagnose problems with handling a particular Cisco router and/or one of
  120.      its interfaces.  Additional diagnositc verbosity may be produced using
  121.      the ----DDDD 11114444333333336666 command line option.  Diagnostics are generated on standard
  122.      error as each sample is fetched and parsed.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. PPPPMMMMDDDDAAAACCCCIIIISSSSCCCCOOOO((((1111))))                                                      PPPPMMMMDDDDAAAACCCCIIIISSSSCCCCOOOO((((1111))))
  137.  
  138.  
  139.  
  140. IIIINNNNSSSSTTTTAAAALLLLLLLLAAAATTTTIIIIOOOONNNN
  141.      If you want access to the names, help text and values for the Cisco
  142.      performance metrics, do the following as root:
  143.  
  144.           # cd /usr/pcp/pmdas/cisco
  145.           # ./Install
  146.  
  147.      If you want to undo the installation, do the following as root:
  148.  
  149.           # cd /usr/pcp/pmdas/cisco
  150.           # ./Remove
  151.  
  152.      Both the Install and Remove scripts take an optional -_N argument to
  153.      specify that just the performance metrics name space for the Cisco
  154.      metrics is to be installed or removed.  This is useful when you wish to
  155.      access Cisco metrics on other machines, but do not wish to have the
  156.      ppppmmmmddddaaaacccciiiissssccccoooo PMDA collecting metrics on the local machine.
  157.  
  158.      ppppmmmmddddaaaacccciiiissssccccoooo is launched by ppppmmmmccccdddd(1) and should never be executed directly.
  159.      The Install and Remove scripts notify ppppmmmmccccdddd(1) when the agent is installed
  160.      or removed.
  161.  
  162. FFFFIIIILLLLEEEESSSS
  163.      ////eeeettttcccc////ppppmmmmccccdddd....ccccoooonnnnffff
  164.                command line options used to launch ppppmmmmddddaaaacccciiiissssccccoooo
  165.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmddddaaaassss////cccciiiissssccccoooo////hhhheeeellllpppp
  166.                default help text file for the Cisco metrics
  167.      ////uuuussssrrrr////ppppccccpppp////ppppmmmmddddaaaassss////cccciiiissssccccoooo////IIIInnnnssssttttaaaallllllll
  168.                installation script for the ppppmmmmddddaaaacccciiiissssccccoooo agent
  169.      ////uuuussssrrrr////ppppccccpppp////ppppmmmmddddaaaassss////cccciiiissssccccoooo////RRRReeeemmmmoooovvvveeee
  170.                undo installation script for the ppppmmmmddddaaaacccciiiissssccccoooo agent
  171.      $$$${{{{PPPPCCCCPPPP____LLLLOOOOGGGGDDDDIIIIRRRR----////vvvvaaaarrrr////aaaaddddmmmm////ppppccccpppplllloooogggg}}}}////cccciiiissssccccoooo....lllloooogggg
  172.                default log file for error messages and other information from
  173.                ppppmmmmddddaaaacccciiiissssccccoooo
  174.  
  175. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  176.      ppppmmmmccccdddd(1)
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.